home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 May / CMCD0505.ISO / Software / Freeware / Comunicatii / openvpn / openvpn-2.0_rc18-gui-1.0-rc5-install.exe / OpenVPN GUI ReadMe.txt < prev    next >
Text File  |  2005-03-16  |  9KB  |  236 lines
  1. Installation Instructions for OpenVPN GUI for Windows
  2. -----------------------------------------------------
  3.  
  4. You can either get my installation package for OpenVPN 2.0_XX where I've
  5. bundled the gui in the installation package, or you can use the original
  6. installation package from OpenVPN, and then manually install OpenVPN GUI.
  7.  
  8. To support multiple simultaneous connections you need at least 
  9. OpenVPN 2.0-beta6.
  10.  
  11.  
  12. Installation using the bundled OpenVPN package with OpenVPN GUI included
  13. ------------------------------------------------------------------------
  14.  
  15. * Download openvpn-2.0_XX-gui-1.0_XX-install.exe from 
  16.   http://openvpn.se
  17.  
  18. * If you have a previous version of OpenVPN GUI installed, shut it down.
  19.   Make sure it's closed by ALL logged on users.
  20.  
  21. * Run the install program. During the installation you can choose if the GUI
  22.   should be started automatically at system startup. The default is yes.
  23.  
  24. * Create a xxxx.ovpn config-file with your favorite texteditor and save it in:
  25.   C:\Program files\OpenVPN\config\. You should NOT use the "log" or "log-append"
  26.   options as OpenVPN GUI redirect the normal output to a log file itself. 
  27.   There is a sample config files in the "sample-config" folder. Please
  28.   refer to the OpenVPN project homepage for more information regarding 
  29.   creating the configuration file. http://openvpn.net/
  30.  
  31.  
  32. Manual installation of OpenVPN GUI
  33. ----------------------------------
  34.  
  35. * Download and install OpenVPN (preferable v2.0-XX) from 
  36.   http://openvpn.net/
  37.  
  38. * Download openvpn-gui-1.0-XX.exe and save it in OpenVPN's bin folder.
  39.   Default is "C:\Program Files\OpenVPN\bin\". You must put it in this folder
  40.   because OpenVPN GUI depends on the OpenSSL DLLs installed in this folder by
  41.   OpenVPN.
  42.  
  43. * Create a xxxx.ovpn config-file with your favorite texteditor and save it in:
  44.   C:\Program files\OpenVPN\config\. You should NOT use the "log" or "log-append"
  45.   options as OpenVPN GUI redirect the normal output to a log file itself. 
  46.   There is a sample config files in the "sample-config" folder. Please
  47.   refer to the OpenVPN project homepage for more information regarding 
  48.   creating the configuration file. http://openvpn.net/
  49.  
  50. * Put a short-cut to openvpn-gui-1.0-XX.exe in your 
  51.   "Start->All Program->StartUp" folder if you want the gui started automatically
  52.   when you logon to Windows.
  53.  
  54. * Start the GUI by double-clicking the openvpn-gui-1.0-XX.exe file.
  55.  
  56. *** You need to be Administrator the first time you run OpenVPN GUI for it to
  57.     create its registry keys. After that you don't have to be administrator
  58.     just to run the GUI, however OpenVPN (2.0-rc4) still requires the user to 
  59.     be administrator to run! ***
  60.  
  61.  
  62. Using OpenVPN GUI
  63. -----------------
  64.  
  65. When OpenVPN GUI is started your config folder (C:\Program Files\OpenVPN\config)
  66. will be scanned for .ovpn files, and an icon will be displayed in the taskbar's
  67. status area.
  68.  
  69. If you do not have any openvpn connection running, the config dir will be
  70. re-scanned for new config files every time you open the OpenVPN GUI menu by
  71. right-clicking the icon.
  72.  
  73. When you choose to connect to a site OpenVPN GUI will launch openvpn with
  74. the specified config file. If you use a passphrase protected key you will be
  75. prompted for the passphrase.
  76.  
  77. If you want OpenVPN GUI to start a connection automatically when it's started,
  78. you can use the --connect cmd-line option. You have to include the extention
  79. for the config file. Example:
  80.  
  81. openvpn-gui --connect office.ovpn
  82.  
  83.  
  84. Run OpenVPN GUI as a Non-Admin user
  85. -----------------------------------
  86.  
  87. OpenVPN currently does not work as a normal (non-admin) user. OpenVPN GUI
  88. 2.0 will solve this by using an enhanced version of the OpenVPN service
  89. to start and stop openvpn processes.
  90.  
  91. In the mean time, it is possible to use OpenVPN GUI to control the current
  92. OpenVPN Service to start and stop a connection.
  93.  
  94. To use OpenVPN GUI to control the OpenVPN service, set the registry value
  95. "service_only" to '1'. See the section about registry values below.
  96.  
  97. Limitations with this way:
  98.   
  99.   There is no way for OpenVPN GUI ta hand over a password to the service
  100.   wrapper, so you can't use passphrase protected private keys or 
  101.   username/password authentication.
  102.  
  103.   If you have multiple openvpn configurations, all will be started and
  104.   stopped at the same time.
  105.  
  106.   OpenVPN GUI is not able to retrieve any status info about the connections
  107.   from OpenVPN, so it will report connected as soon as the service is
  108.   started regarless of if OpenVPN has really succeded to connect or not.
  109.  
  110.   You cannot see the OpenVPN log in real-time.
  111.  
  112.  
  113. Run Connect/Disconnect/Preconnect Scripts
  114. -----------------------------------------
  115.  
  116. There are three diffrent scripts that OpenVPN GUI can execute to help
  117. with diffrent tasks like mapping network drives.
  118.  
  119. Preconnect  If a file named "xxx_pre.bat" exist in the config folder
  120.             where xxx is the same as your OpenVPN config file name,
  121.             this will be executed BEFORE the OpenVPN tunnel is established.
  122.  
  123. Connect     If a file named "xxx_up.bat" exist in the config folder
  124.             where xxx is the same as your OpenVPN config file name,
  125.             this will be executed AFTER the OpenVPN tunnel is established.
  126.  
  127. Disconnect  If a file named "xxx_down.bat" exist in the config folder
  128.             where xxx is the same as your OpenVPN config file name,
  129.             this will be executed BEFORE the OpenVPN tunnel is closed.
  130.  
  131.  
  132. Registry Values affecting the OpenVPN GUI operation
  133. ---------------------------------------------------
  134.  
  135. All OpenVPN GUI reg-values are located below the following key:
  136. HKEY_LOCAL_MACHINE\SOFTWARE\OpenVPN-GUI\
  137.  
  138. The follow keys are used to control the OpenVPN GUI
  139.  
  140. config_dir
  141.     configuration file directory, defaults to "C:\Program Files\OpenVPN\config"
  142.  
  143. config_ext
  144.     file extension on configuration files, defaults to "ovpn"
  145.  
  146. connectscript_timeout
  147.     Time in seconds to wait for the connect script to finish. If set to 0
  148.     the exitcode of the script is not checked.
  149.  
  150. disconnectscript_timeout
  151.     Time in seconds to wait for the disconnect script to finish. Must be a
  152.     value between 1-99.
  153.  
  154. preconnectscript_timeout
  155.     Time in seconds to wait for the preconnect script to finish. Must be a
  156.     value between 1-99.
  157.  
  158. exe_path
  159.     path to openvpn.exe, defaults to "C:\Program Files\OpenVPN\bin\openvpn.exe"
  160.  
  161. log_dir
  162.     log file directory, defaults to "C:\Program Files\OpenVPN\log"
  163.  
  164. log_append
  165.     if set to "0", the log file will be truncated every time you start a
  166.     connection. If set to "1", the log will be appended to the log file.
  167.   
  168. priority
  169.     the windows priority class for each instantiated OpenVPN process, 
  170.     can be one of:
  171.  
  172.         * "IDLE_PRIORITY_CLASS"
  173.         * "BELOW_NORMAL_PRIORITY_CLASS"
  174.         * "NORMAL_PRIORITY_CLASS" (default)
  175.         * "ABOVE_NORMAL_PRIORITY_CLASS"
  176.         * "HIGH_PRIORITY_CLASS"
  177.  
  178. allow_edit
  179.     If set to "1", the Edit config menu will be showed.
  180.  
  181. allow_password
  182.     If set to "1", the Change Password menu will be showed.
  183.  
  184. allow_proxy
  185.     If set to "1", the Proxy Settings menu will be showed.
  186.  
  187. allow_service
  188.     If set to "1", the Service control menu will be showed.
  189.  
  190. silent_connection
  191.     If set to "1", the status window with the OpenVPN log output will
  192.     not be showed while connecting.
  193.  
  194. service_only
  195.     If set to "1", OpenVPN GUI's normal "Connect" and "Disconnect"
  196.     actions are changed so they start/stop the OpenVPN service instead
  197.     of launching openvpn.exe directly.
  198.  
  199. show_balloon
  200.     If set to "0" - Never show any connected balloon.
  201.               "1" - Show balloon after initial connection is established.
  202.               "2" - Show balloon even after re-connects.
  203. log_viewer
  204.     The program used to view your log files, defaults to
  205.     "C:\windows\notepad.exe"
  206.  
  207. editor
  208.     The program used to edit your config files, defaults to
  209.     "C:\windows\notepad.exe"
  210.  
  211. passphrase_attempts
  212.     Number of attempts to enter the passphrase to allow. 
  213.  
  214. All these registry options is also available as cmd-line options.
  215. Use "openvpn-gui --help" for more info about cmd-line options.
  216.  
  217.  
  218. If you have any problem getting OpenVPN GUI to work you can reach me via
  219. email at mathias@nilings.se.
  220.  
  221.  
  222. Building OpenVPN GUI from source
  223. --------------------------------
  224.  
  225. * Download and install MinGW and MSYS from http://www.mingw.org/
  226.   I'm using MinGW-3.2.0-rc-3 and MSYS-1.0.10.
  227.  
  228. * Download and install the binary distribution of OpenSSL from
  229.   http://www.slproweb.com/products/Win32OpenSSL.html
  230.  
  231. * Download and extract the OpenVPN GUI source archive.
  232.  
  233. * Start a bash shell by running msys.bat.
  234.  
  235. * Run "make" from the OpenVPN GUI source directory. 
  236.